Vcenter Lcm Deployment Common Network

The Vcenter Lcm Deployment Common Network schema defines the network configuration.

This schema was added in vSphere API 9.0.0.0.

JSON Example

{
    "ip_family": "string",
    "mode": "string",
    "ip": "string",
    "dns_servers": [
        "string"
    ],
    "prefix": 0,
    "gateway": "string",
    "hostname": "string"
}

string

ip_family

Optional

Network IP address family.

For more information see: Vcenter Lcm Deployment Common Network IpType.

This property was added in vSphere API 9.0.0.0.

If missing or null defaults to IPv4

string

mode

Required

Network mode.

For more information see: Vcenter Lcm Deployment Common Network NetworkMode.

This property was added in vSphere API 9.0.0.0.

string

Optional

Network IP address. Required for static mode only.

This property was added in vSphere API 9.0.0.0.

This property is optional and it is only relevant when the value of mode is Vcenter Lcm Deployment Common Network NetworkMode.STATIC.

array of string

dns_servers

Optional

A comma-separated list of IP addresses of DNS servers.Required for static mode only. A JSON array such as ["1.2.3.4", "127.0.0.1"]. The DNS servers must be reachable from the source appliance and only the first two will be used.

This property was added in vSphere API 9.0.0.0.

This property is optional and it is only relevant when the value of mode is Vcenter Lcm Deployment Common Network NetworkMode.STATIC.

integer As int64 As int64

prefix

Optional

Network prefix length. Required for static mode only. This is the number of bits set in the subnet mask; for instance, if the subnet mask is 255.255.255.0, there are 24 bits in the binary version of the subnet mask, so the prefix length is 24. If used, the values must be in the inclusive range of 0 to 32 for IPv4 and 0 to 128 for IPv6.

This property was added in vSphere API 9.0.0.0.

This property is optional and it is only relevant when the value of mode is Vcenter Lcm Deployment Common Network NetworkMode.STATIC.

string

gateway

Optional

Gateway of the network. Required for static mode only.

This property was added in vSphere API 9.0.0.0.

This property is optional and it is only relevant when the value of mode is Vcenter Lcm Deployment Common Network NetworkMode.STATIC.

string

hostname

Optional

Primary network identity. Can be either an IP address or a fully qualified domain name(FQDN).

This property was added in vSphere API 9.0.0.0.

hostname may not be applicable